Get all wallets by filter
The Get all wallets by filter API is used to fetch wallets based on the provided filter criteria. The response provides details about the wallets' availability status and other relevant information. Supporting filter key values: Name, Number and publickey.
Method: POST
{{URL}}/jsonrpc
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Example
Payload Parameters
| Parameter | Description |
|---|---|
Key Mandatory | String The filter key, which can be "name", "number", or "publickey" Ex:"name " |
Value Mandatory | String The value to filter by Ex:"test " |
customerID Mandatory | String The customer ID associated with the wallets Ex:"100000000048001 " |
- cURL
- C#
- Go
- NodeJs
curl --location 'https://wallet.netxd.com/plwallet/rpc/WalletService/GetAllWalletsByFilter' \
--header 'DeviceID: 8020' \
--header 'Signature: keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx' \
--data '{"Key":"name","Value":"test","customerID":"100000000048001"}'
var options = new RestClientOptions("https://wallet.netxd.com")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/plwallet/rpc/WalletService/GetAllWalletsByFilter", Method.Post);
request.AddHeader("DeviceID", "8020");
request.AddHeader("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx");
var body = @"{" + "\n" +
@" ""Key"": ""name""," + "\n" +
@" ""Value"": ""test""," + "\n" +
@" ""customerID"": ""100000000048001""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://wallet.netxd.com/plwallet/rpc/WalletService/GetAllWalletsByFilter"
method := "POST"
payload := strings.NewReader(`{
"Key": "name",
"Value": "test",
"customerID": "100000000048001"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("DeviceID", "8020")
req.Header.Add("Signature", "keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'POST',
'hostname': 'wallet.netxd.com',
'path': '/plwallet/rpc/WalletService/GetAllWalletsByFilter',
'headers': {
'DeviceID': '8020',
'Signature': 'keyId=8020,algorithm=ecdsa-sha256,signature=MEUCIQCNi1vjPf/HpI9R2DXnc0Zt1s6YmWyA4H1x813lJ+tuDgIgB+lrc+iCMyTUGiraG9kGKNDXYiz7RfBBtifr5wUQs54=',
'Content-Type': 'application/json',
'Authorization': 'Basic ci5hbmJhbGFnYW5AbmV0eGQuY29tOmQ0Mjc2ZmIx'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"Key": "name",
"Value": "test",
"customerID": "100000000048001"
});
req.write(postData);
req.end();
Body
{
"Key": "name",
"Value": "test",
"customerID": "100000000048001"
}
Response: 200
Response Parameters
| Parameter | Description |
|---|---|
AvailabilityStatus | String Indicates the availability status of the wallet Ex:"TICKET_EXISTS " Possible values:AVAILABLE – There is no Beneficiary associated with the account TICKET_EXISTS – There is an open ticket exists with the account for Beneficiary creation ALREADY_EXISTS – There is a Beneficiary associated with the account with status either Active or Inactive DELETED – There is a Beneficiary with that account with the status Deleted |
_id | String The unique identifier of the wallet Ex:"1339001 " |
customerId | String The customer ID associated with the wallet Ex:"100000000048001 " |
customerName | String The name of the customer Ex:"NETXDNETXD" |
institutionName | String The name of the institution Ex:"NETXD " |
name | String The name of the wallet Ex:"AuditTest " |
number | String The wallet number Ex:"9991339002 " |
publickey | String The public key associated with the wallet Ex:"GA2OTONCC2WOEN6KH5VNG6KUGTTGP4YI776ZJSY5Q4DPTGYRW7UEYIFV " |
[
{
"AvailabilityStatus": "TICKET_EXISTS",
"_id": "1339001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "AuditTest",
"number": "9991339002",
"publickey": "GA2OTONCC2WOEN6KH5VNG6KUGTTGP4YI776ZJSY5Q4DPTGYRW7UEYIFV"
},
{
"AvailabilityStatus": "ALREADY_EXISTS",
"_id": "1342001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "AuditTest1",
"number": "9991342002",
"publickey": "GBNE4YRBYZN3T3STTWFYKAJM2NWMMQXY3MBVFL6BHFUAPUI7YD3IVF6F"
},
{
"AvailabilityStatus": "AVAILABLE",
"_id": "1349001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "MergeTest",
"number": "9991349002",
"publickey": "GDLTCUQ5LGLFM7JGKPYMPA5FEN2EMNKT2ASKZDDNF4TMB3PK7R3KYBGL"
},
{
"AvailabilityStatus": "ALREADY_EXISTS",
"_id": "1404001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "ws146test",
"number": "9991404002",
"publickey": "GBKA5OWL2NOI2MKYU6ROHVIBHTGKCH3FOCRIGNXETAM7R7AE7YR3J6EW"
},
{
"AvailabilityStatus": "DELETED",
"_id": "1421003",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "ws94 test3",
"number": "9991421004",
"publickey": "GD3GV2IZROEZWKOT5MVTR2LFVFEEJLWOHLZZEJ4OW3VS2ZKG6LHN46DZ"
},
{
"AvailabilityStatus": "AVAILABLE",
"_id": "1424001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "ws94 test4",
"number": "9991424002",
"publickey": "GBWHB6HEPJPT5WV7UJTLAKPAGV336ER55FCEZFT5QGYOEME75HPS3EYT"
},
{
"AvailabilityStatus": "ALREADY_EXISTS",
"_id": "1455001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "channelAccountsTest",
"number": "9991455002",
"publickey": "GBU7R5RQYKWWKDXDBYA23NLFKDI2CWQACXSC2SEBXQNYLFD2QFG3DUFR"
},
{
"AvailabilityStatus": "AVAILABLE",
"_id": "1455004",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "channelAccountsTest1",
"number": "9991455005",
"publickey": "GADRCYWUJQ5DIRPSIVMQ2LADQEPRWKAFRO43JZET4ORHGDXZ7EKNFWEP"
},
{
"AvailabilityStatus": "AVAILABLE",
"_id": "1461001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "channelAccountsTest2",
"number": "9991461002",
"publickey": "GAQGXIDGQROQ6CJQZZFN2SDVUI76JYBNM45SGPY2OHX4ERR5JYN3OJGY"
},
{
"AvailabilityStatus": "ALREADY_EXISTS",
"_id": "1490001",
"customerId": "100000000048001",
"customerName": "NETXDNETXD",
"institutionName": "NETXD",
"name": "channelAccountsTest9",
"number": "9991490002",
"publickey": "GCLOH3OZLQBYROBHAQIK4B7DCC3PLRKJJYTEU3NB6QH23SSTBHUOIDN4"
}
]